List Recipients
AutomatR.DocuSign.Activities.ListRecipients
The "List Recipients" activity in AutomatR is part of the DocuSign Recipients package, providing the capability to retrieve information about recipients associated with a specific envelope in DocuSign. This activity offers flexibility in including various details such as anchor tab locations, extended information, metadata, and tabs in the response.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID to identify the DocuSign envelope for which recipients need to be retrieved. This field supports only Strings or String variables. |
| Include Anchor Tab Locations | Specify whether to include anchor tab locations in the response. Enter "true" or "false." String variables containing the value. |
| Include Extended | Specify whether to include extended details in the response. Enter "true" or "false." String variables containing the value. |
| Include MetaData | When true, the response includes metadata that indicates which properties the sender can edit. Enter "true" or "false." String variables containing the value. |
| Include Tabs | Specify whether to include document tabs in the response. Enter "true" or "false." String variables containing the value. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "List Recipients" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the list of recipient information for the envelope with data type List<Signer>. Variables of data type List<Signer> to store recipient details. |
How to use:
- Drag and drop the "List Recipients" activity onto the workflow.
- Configure the properties by specifying the Envelope ID and optionally, other filtering parameters.
- Execute the workflow to retrieve information about recipients associated with the specified envelope.
Important Notes:
- Ensure that the "List Recipients" activity is used within the scope of the "DocuSign Scope" activity.
- Carefully set the optional properties based on the desired details to be included in the response.
Example: Consider an example where the "List Recipients" activity is used to retrieve information about recipients associated with an envelope:
List Recipients:
Delay: 5
Envelope ID: "env123"
Include Anchor Tab Locations: "true"
Include Extended: "false"
Include MetaData: "true"
Include Tabs: "true"
Response: envelopeRecipients
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves information about recipients associated with the envelope having ID "env123." The details of the recipients are stored in the variable "envelopeRecipients" for further processing in the workflow.